<html>
<body>
<h1>Resources Plugin</h1>

<div id="content-before">
</div>

<div id="extract">
    <p>Extract copies resources from within another artifact.</p>
    <b>Available Properties</b>
    <table border="1" cellpadding="2" cellspacing="0">
        <tbody>
            <tr>
                <td valign="top"><b>Property</b></td>
                <td valign="top"><b>Description</b></td>
                <td valign="top"><b>Required</b></td>
            </tr>
            <tr>
                <td>artifactPath</td>
                <td>A quokka file set. Note: the dir sub refers to the root directory
                    to extract from within the artifact.
                </td>
            </tr>
            <tr>
                <td>resources</td>
                <td>A quokka file set. Note: the dir sub refers to the root directory
                    to extract from within the artifact.
                </td>
            </tr>

        </tbody>
    </table>
</div>

<div id="process-resources">
    <p>Notes: </p>
    <ul>
        <li>Copying of resources is forced if the value of any token is changed. Tokens may include
        quokka properties (includes system properties) and any properties defined in filters. Tokens can
        be ignored by using the ignoredTokensPrefix and defining a map of tokens to ignore with
        the prefix specified.</li>
        <li>To use token substitution, use the token name surrounded by '@' characters in your
        resources. e.g. @myfile@ will get replaced with the value of the myfile token if it is defined.</li>
        <li>Special token suffixes can be used that normalise, or escape the value of a property. e.g. you
            could use @myfile--norm@ to substitute a normalised version of a path. Suffixes are:
            <ul>
                <li>--norm: Normalises a path, fixing path and directory separators for the current platform</li>
                <li>--esc: Escapes a string for use inside a properties file. e.g. C:\Temp becomes C:\\Temp</li>
                <li>--norm,esc: Performs both of the above operations.</li>
            </ul>
        </li>
    </ul>

    <b>Available Properties</b>
    <table border="1" cellpadding="2" cellspacing="0">
        <tbody>
            <tr>
                <td valign="top"><b>Property</b></td>
                <td valign="top"><b>Description</b></td>
                <td valign="top"><b>Required</b></td>
            </tr>
            <tr>
                <td>includeGeneratedResources</td>
                <td>If true, copies any generated resources as well</td>
                <td>Yes</td>
            </tr>
            <tr>
                <td>output</td>
                <td>The directory to copy the resources to.</td>
                <td>Yes</td>
            </tr>
            <tr>
                <td>filtered</td>
                <td>A map of filesets that contain resources that will be processed with filtering (token substitution)</td>
                <td>No</td>
            </tr>
            <tr>
                <td>unfiltered</td>
                <td>A map of filesets that contain resources that will be processed without filtering (token substitution)</td>
                <td>No</td>
            </tr>
            <tr>
                <td>unfiltered</td>
                <td>A map of filesets that contain resources that will be processed without filtering (token substitution)</td>
                <td>No</td>
            </tr>
            <tr>
                <td>filters</td>
                <td>A map of filesets that contain filters. The filters should be property files containing name/value
                pairs of tokens.</td>
                <td>No</td>
            </tr>
            <tr>
                <td>ignoredTokensPrefix</td>
                <td>The property prefix for tokens to ignore. Defaults to quokka.resources.</td>
                <td>No. Defaults to quokka.resources.</td>
            </tr>
            <tr>
                <td>addPropertiesAsTokens</td>
                <td>If true, quokka properties (includes system properties) are added as tokens for filtering.</td>
                <td>No. Defaults to true.</td>
            </tr>

        </tbody>
    </table>
</div>

<div id="process-test-resources">
    <p>Process test resources supports the same properties as process-resources.</p>
</div>

</body>
</html>